Description

Implemented plugin options as a TypeScript interface.

The options interface extends ParserOptions and adds several plugin specific options:

• apply?: Conditional application
• enforce?: Plugin ordering
• exclude?: Glob patterns matching files to exclude from parsing. Applied after include
• handler?: Apply additional processing to a ComponentDoc before __docgenInfo is declared + assigned a value
• include?: Glob patterns matching files to parse for docgen information
• name?: Generate the name of the component to add a __docgenInfo property to
• tsconfig?: Name of tsconfig file or path to tsconfig file

Tests

N/A

Additional context

• Docs for exclude and include reference micromatch

  Vite exposes @rollup/pluginutils's createFilter function to encourage Vite specific plugins and integrations to use the standard include/exclude filtering pattern, which is also used in Vite core itself.

  - Filtering, include/exclude pattern, Vite Plugin API

  createFilter uses picomatch under the hood. Unlike micromatch, picomatch does not support brace expansion. For now, micromatch will be used. This topic will be revisited in 🔨 docgen parsing #2, however.

Linked issues

closes #1

Submission checklist

• pr title prefixed with PR: (e.g: PR: User authentication)
• pr title describes functionality (not vague title like Update index.md)
• pr targets branch next
• project was run locally to verify that there are no errors
• documentation added or updated